Skip to content

Conversation

@balteravishay
Copy link
Contributor

This PR adds a new guide by the BP, AI/ML WGs and the Memory Safety SIG

Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Copy link
Contributor

@gkunz gkunz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work. I spent some time thinking about additional suggestions, but eventually gave up. :-)

I was also thinking about if it would be beneficial to lay out the guide in a way that makes it easier to adopt a "recommended set of instructions", e.g. a tl;dr section as it exists in the C/C++ Compiler Guide, but I see a risk of duplicating large parts of the content. So, just take it as a question, but not a strong suggestion.

@balteravishay
Copy link
Contributor Author

balteravishay commented Jul 15, 2025

Tracking change requests from the WG meeting

  • Add TL/DR
  • Add citations
  • Add examples

@david-a-wheeler
Copy link
Contributor

I'd like to see citations added that show that "this actually works", but don't make that a blocker, add them as we go.

@david-a-wheeler
Copy link
Contributor

I think at the top there should be a "TL;DR" paragraph that users can copy & paste in as instructions. That paragraph should have the text snippets outlined below.

@balteravishay balteravishay merged commit c4e4236 into ossf:main Jul 15, 2025
2 checks passed
dwiley258 pushed a commit to dwiley258/wg-best-practices-os-developers that referenced this pull request Jul 31, 2025
…f#936)

* guide
Signed-off-by: balteravishay <[email protected]>

* guide

Signed-off-by: balteravishay <[email protected]>

* remove temp files
Signed-off-by: balteravishay <[email protected]>

* lint

Signed-off-by: balteravishay <[email protected]>

* Update docs/Security-Focused-Guide-for-AI-Code-Assistant-Instructions.md

Signed-off-by: Avishay Balter <[email protected]>

* Update docs/Security-Focused-Guide-for-AI-Code-Assistant-Instructions.md

Signed-off-by: Avishay Balter <[email protected]>

---------

Signed-off-by: balteravishay <[email protected]>
Signed-off-by: Avishay Balter <[email protected]>
Signed-off-by: ewlxdnx <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants